Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs/how-tos/ pre-commit #750

Merged
merged 2 commits into from
Mar 11, 2024
Merged

docs/how-tos/ pre-commit #750

merged 2 commits into from
Mar 11, 2024

Conversation

zilto
Copy link
Collaborator

@zilto zilto commented Mar 8, 2024

The docs page introduces pre-commit hooks and how to add the custom Hamilton hooks

Changes

How I tested this

  • build the docs locally

Notes

  • the GitHub actions should be consistent with the pre-commit hooks for consistency and ease of maintenance (i.e., the user interface is a list of CLI commands)

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Project documentation has been updated if adding/changing functionality.

@zilto zilto added the documentation Improvements or additions to documentation label Mar 8, 2024
Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Looks good to me!

  • Reviewed the entire pull request up to 2f04160
  • Looked at 157 lines of code in 2 files
  • Took 42 seconds to review
More info
  • Skipped 2 files when reviewing.
  • Skipped posting 1 additional comments because they didn't meet confidence threshold of 50%.
1. /docs/how-tos/pre-commit-hooks.md:136:
  • Assessed confidence : 0%
  • Comment:
    The documentation is clear and well-written. It provides a good introduction to pre-commit hooks and how to use them in the Hamilton project. Good job!
  • Reasoning:
    The PR is adding a new documentation page about pre-commit hooks. The content is well-written and informative. It explains what pre-commit hooks are, how to add them to a project, and how to use custom Hamilton pre-commit hooks. The PR also includes a link to the Hamilton hooks repository. The PR description mentions that the author has tested the changes by building the docs locally. The changes are limited to a single goal and the code has passed the pre-commit check. The PR title is informative and the PR description is well-written. The PR follows the single responsibility principle. The PR does not contain any secrets or credentials. The PR does not log sensitive data. The PR does not contain any extremely complicated code that needs comments. The PR uses descriptive variable and constant names. The PR does not have WIP in the title or body description. The PR does not contain any logical bugs, performance bugs, or security bugs. The PR does not violate any best practices. The PR does not contain any DRY violations. The PR does not contain any function or method naming inconsistencies. The PR does not contain any changes that need to be added to the sphinx documentation under docs/.

Workflow ID: wflow_JQtrSNIIA2FulKqg


Not what you expected? You can customize the content of the reviews using rules. Learn more here.

docs/how-tos/pre-commit-hooks.md Outdated Show resolved Hide resolved
docs/how-tos/pre-commit-hooks.md Outdated Show resolved Hide resolved
docs/how-tos/pre-commit-hooks.md Outdated Show resolved Hide resolved
@zilto zilto merged commit 1da747c into main Mar 11, 2024
23 checks passed
@zilto zilto deleted the feat/pre-commit-hooks branch March 11, 2024 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants